home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Bonobo / Dock.pod next >
Encoding:
Text File  |  2008-06-15  |  2.4 KB  |  187 lines
  1. =head1 NAME
  2.  
  3. Gnome2::Bonobo::Dock
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Glib::InitiallyUnowned
  9.        +----Gtk2::Object
  10.             +----Gtk2::Widget
  11.                  +----Gtk2::Container
  12.                       +----Gnome2::Bonobo::Dock
  13.  
  14. =head1 INTERFACES
  15.  
  16.   Glib::Object::_Unregistered::AtkImplementorIface
  17.   Gtk2::Buildable
  18.  
  19.  
  20. =head1 METHODS
  21.  
  22. =head2 widget = Gnome2::Bonobo::Dock-E<gt>B<new> 
  23.  
  24. =over
  25.  
  26. =back
  27.  
  28. =head2 $dock-E<gt>B<add_floating_item> ($widget, $x, $y, $orientation)
  29.  
  30. =over
  31.  
  32. =over
  33.  
  34. =item * $widget (Gnome2::Bonobo::DockItem) 
  35.  
  36. =item * $x (integer) 
  37.  
  38. =item * $y (integer) 
  39.  
  40. =item * $orientation (Gtk2::Orientation) 
  41.  
  42. =back
  43.  
  44. =back
  45.  
  46. =head2 boolean = $dock-E<gt>B<add_from_layout> ($layout)
  47.  
  48. =over
  49.  
  50. =over
  51.  
  52. =item * $layout (Gnome2::Bonobo::DockLayout) 
  53.  
  54. =back
  55.  
  56. =back
  57.  
  58. =head2 $dock-E<gt>B<add_item> ($item, $placement, $band_num, $position, $offset, $in_new_band)
  59.  
  60. =over
  61.  
  62. =over
  63.  
  64. =item * $item (Gnome2::Bonobo::DockItem) 
  65.  
  66. =item * $placement (Gnome2::Bonobo::DockPlacement) 
  67.  
  68. =item * $band_num (integer) 
  69.  
  70. =item * $position (integer) 
  71.  
  72. =item * $offset (integer) 
  73.  
  74. =item * $in_new_band (boolean) 
  75.  
  76. =back
  77.  
  78. =back
  79.  
  80. =head2 $dock-E<gt>B<allow_floating_items> ($enable)
  81.  
  82. =over
  83.  
  84. =over
  85.  
  86. =item * $enable (boolean) 
  87.  
  88. =back
  89.  
  90. =back
  91.  
  92. =head2 widget = $dock-E<gt>B<get_client_area> 
  93.  
  94. =over
  95.  
  96. =back
  97.  
  98. =head2 $dock-E<gt>B<set_client_area> ($widget)
  99.  
  100. =over
  101.  
  102. =over
  103.  
  104. =item * $widget (Gtk2::Widget) 
  105.  
  106. =back
  107.  
  108. =back
  109.  
  110. =head2 list = $dock-E<gt>B<get_item_by_name> ($name)
  111.  
  112. =over
  113.  
  114. =over
  115.  
  116. =item * $name (string) 
  117.  
  118. =back
  119.  
  120.  
  121. Returns a BonoboDockItem, a BonoboDockPlacement and three unsigned integers
  122. correspoding to num_band, band_position and offset.
  123.  
  124.  
  125. =back
  126.  
  127. =head2 docklayout = $dock-E<gt>B<get_layout> 
  128.  
  129. =over
  130.  
  131. =back
  132.  
  133.  
  134. =head1 SIGNALS
  135.  
  136. =over
  137.  
  138. =item B<layout-changed> (Gnome2::Bonobo::Dock)
  139.  
  140. =back
  141.  
  142.  
  143. =head1 ENUMS AND FLAGS
  144.  
  145. =head2 enum Gnome2::Bonobo::DockPlacement
  146.  
  147. =over
  148.  
  149. =item * 'top' / 'BONOBO_DOCK_TOP'
  150.  
  151. =item * 'right' / 'BONOBO_DOCK_RIGHT'
  152.  
  153. =item * 'bottom' / 'BONOBO_DOCK_BOTTOM'
  154.  
  155. =item * 'left' / 'BONOBO_DOCK_LEFT'
  156.  
  157. =item * 'floating' / 'BONOBO_DOCK_FLOATING'
  158.  
  159. =back
  160.  
  161.  
  162. =head2 enum Gtk2::Orientation
  163.  
  164. =over
  165.  
  166. =item * 'horizontal' / 'GTK_ORIENTATION_HORIZONTAL'
  167.  
  168. =item * 'vertical' / 'GTK_ORIENTATION_VERTICAL'
  169.  
  170. =back
  171.  
  172.  
  173.  
  174. =head1 SEE ALSO
  175.  
  176. L<Gnome2>, L<Glib::Object>, L<Glib::InitiallyUnowned>, L<Gtk2::Object>, L<Gtk2::Widget>, L<Gtk2::Container>
  177.  
  178. =head1 COPYRIGHT
  179.  
  180. Copyright (C) 2003-2004 by the gtk2-perl team.
  181.  
  182. This software is licensed under the LGPL.  See L<Gnome2> for a full notice.
  183.  
  184.  
  185. =cut
  186.  
  187.